PC User 2003 December/Australian PC User - December 2003 (CD2).iso/software/apps/files/dwmx2k4.exe/Disk1/data1.cab/Configuration_En/DataSources/ColdFusion/CFSTOREDPROC.js

JavaScript | 2003-09-05 | 8.8 KB | 307 lines

// Copyright 2001, 2002, 2003 Macromedia, Inc. All rights reserved.
var STOREDPROC_FILENAME = "SP_D.gif"
var DATASOURCE_LEAF_FILENAME = "DSL_D.gif"


//--------------------------------------------------------------------
// FUNCTION:
//   addDynamicSource
//
// DESCRIPTION:
//   Displays the Stored Procedure Server Behavior dialog
//
// ARGUMENTS:
//   none
//
// RETURNS:
//   nothing
//--------------------------------------------------------------------

function addDynamicSource()
{
  dw.popupServerBehavior("CFStoredProc.htm");
}


//--------------------------------------------------------------------
// FUNCTION:
//   findDynamicSource
//
// DESCRIPTION:
//   Called by UD to locate instances of this data source on the page.
//
// ARGUMENTS:
//   none
//
// RETURNS:
//   array of objects with five properties: title, imageFile, allowDelete,
//   dataSource, and name.
//--------------------------------------------------------------------

function findDynamicSources()
{
  var retList = new Array();

  var dom = dreamweaver.getDocumentDOM();
  if (dom)
  {
    var fileURL = dom.URL;

    if (fileURL.length)
    {
      dwscripts.copyDesignNotesFromTempURL();
    }

    var sbObjs = dwscripts.getServerBehaviorsByFileName("CFStoredProc.htm");
    for (var i=0; i < sbObjs.length; i++)
    {
      var bAddDataSource = false;

      // Note that the recordset datasource will handle creating datasources
      //   for recordsets returned from stored procs.

      // Add a datasource if the stored proc returns the status code.
      var statusCodeVarName = sbObjs[i].getStatusCodeVarName();
      if (statusCodeVarName)
      {
        bAddDataSource = true;
      }

      // Add a datasource if the stored proc has any output variables.
      var callParams = new Array();
      sbObjs[i].getDatabaseCall(callParams);
      if (callParams.length > 0 && !bAddDataSource)
      {
        for (var j = 0; !bAddDataSource && j < callParams.length; ++j)
        {
          var varType = callParams[j].varType.toUpperCase();
          if (varType.indexOf("OUT") != -1)
          {
            bAddDataSource = true;
          }
        }
      }

      if (bAddDataSource)
      {
        retList.push(new DataSource(sbObjs[i].getTitle(), STOREDPROC_FILENAME,
                     true, "CFSTOREDPROC.htm", ""));
      }
    }
  }

  return retList;
}


//--------------------------------------------------------------------
// FUNCTION:
//   generateDynamicSourceBindings
//
// DESCRIPTION:
//   Given a one of the title strings returned from findDynamicSource,
//   this function returns the source bindings associated with that
//   Stored Procedure.
//
// ARGUMENTS:
//   sourceName - One of the title strings returned in findDynamicSource
//
// RETURNS:
//   Returns a list of bindings for the given sourceName
//--------------------------------------------------------------------

function generateDynamicSourceBindings(sourceName)
{
  var retList = new Array();

  // find the sbobj for the stored proc
  var sbObjs = dwscripts.getServerBehaviorsByTitle(sourceName);
  if (sbObjs && sbObjs.length)
  {
    // Add a binding for the status code if it is returned.
    var statusCodeVarName = sbObjs[0].getStatusCodeVarName();
    if (statusCodeVarName)
    {
      retList.push(new DataSourceBinding(statusCodeVarName, DATASOURCE_LEAF_FILENAME,
                                         false, "CFSTOREDPROC.htm", ""));
    }

    // Add a binding for each 'out' or 'inout' parameter.
    var callParams = new Array();
    sbObjs[0].getDatabaseCall(callParams);
    if (callParams.length > 0)
    {
      for (var j = 0; j < callParams.length; ++j)
      {
        var varType = callParams[j].varType.toUpperCase();
        if (varType.indexOf("OUT") != -1)
        {
          retList.push(new DataSourceBinding(callParams[j].cfVarName, DATASOURCE_LEAF_FILENAME,
                                             false, "CFSTOREDPROC.htm", ""));
        }
      }
    }
  }

  return retList;
}


//--------------------------------------------------------------------
// FUNCTION:
//   generateDynamicDataRef
//
// DESCRIPTION:
//   Returns a dynamic binding string for the given source and binding
//
// ARGUMENTS:
//   sourceName - the name of a data source
//   bindingName - the name of a binding within that source
//
// RETURNS:
//   Returns a dynamic binding string
//--------------------------------------------------------------------

function generateDynamicDataRef(sourceName,bindingName,dropObject)
{
  var retVal = "";

  var sbObjs = dwscripts.getServerBehaviorsByTitle(sourceName);
  if (sbObjs && sbObjs.length)
  {
    var paramObj = new Object();
    paramObj.bindingName = bindingName;
    retVal = extPart.getInsertString("", "CFStoredProc_DataRef", paramObj);

    // We need to strip the cfoutput tags if we are inserting into a CFOUTPUT tag
    // or binding to the attributes of a ColdFusion tag.
    if (dwscripts.canStripCfOutputTags(dropObject, true))
    {
      retVal = dwscripts.stripCFOutputTags(retVal, true);
    }
  }

  return retVal;
}


//--------------------------------------------------------------------
// FUNCTION:
//   inspectDynamicDataRef
//
// DESCRIPTION:
//   Inspects a dynamic binding string and returns a pair of
//   source and binding names.
//
// ARGUMENTS:
//   expression - a dynamic binding string
//
// RETURNS:
//   An array of two items.
//   The source name, and the binding name for the given string.
//--------------------------------------------------------------------

function inspectDynamicDataRef(expression)
{
  var retVal = null;

  if (expression.length)
  {
    var params = extPart.findInString("CFStoredProc_DataRef", expression);

    if (params)
    {
      // Find the original stored procedure that uses the output parameter
      //   or the return status code variable refered to in this expression.
      var sbObjs = dwscripts.getServerBehaviorsByFileName("CFStoredProc.htm");
      var bFoundParent = false;
      for (var i=0; !bFoundParent && i < sbObjs.length; i++)
      {
        // First check if it's an output parameter in the current sbObj.
        var callParams = new Array();
        sbObjs[i].getDatabaseCall(callParams);
        for (var j = 0; !bFoundParent && j < callParams.length; ++j)
        {
          if (callParams[j].cfVarName.toUpperCase() == params.bindingName.toUpperCase())
          {
            // Note that it's possible two stored procedures reference the same
            //   output parameter. If this is the case, we'll just take the first.
            bFoundParent = true;
          }
        }

        // If not found yet, it could be a reference to the returned status code
        //   variable for the current sbObj.
        if (!bFoundParent)
        {
          var statusCodeVarName = sbObjs[i].getStatusCodeVarName();
          if (   statusCodeVarName
              && statusCodeVarName.toUpperCase() == params.bindingName.toUpperCase()
             )
          {
            bFoundParent = true;
          }
        }

        // Build return array if we've found the correct stored proc object.
        if (bFoundParent)
        {
          retVal = new Array();
          retVal[0] = sbObjs[i].getTitle();
          retVal[1] = params.bindingName;
        }
      }
    }
  }

  return retVal;
}


//--------------------------------------------------------------------
// FUNCTION:
//   deleteDynamicSource
//
// DESCRIPTION:
//   Deletes a dynamic source from the document.
//
// ARGUMENTS:
//   sourceName - a data source name
//   bindingName - one of the bindings for that data source
//
// RETURNS:
//   nothing
//--------------------------------------------------------------------

function deleteDynamicSource(sourceName,bindingName)
{
  var sbObjs = dwscripts.getServerBehaviorsByTitle(sourceName);

  if (sbObjs.length > 0 && !bindingName)
  {
    // Warn the user that this operation will delete the recordset datasource
    //   that is returned from this stored proc. Make sure this is the desired
    //   action.
    var returnedRSName = sbObjs[0].getRecordsetName();
    var continueDelete = true;
    if (returnedRSName)
    {
      var displayName = dwscripts.getRecordsetDisplayName();
      continueDelete = confirm(dwscripts.sprintf(MM.MSG_WarnDeleteReturnedRS,
                                                 displayName,
                                                 returnedRSName,
                                                 displayName));
    }

    if (continueDelete)
    {
      dw.serverBehaviorInspector.deleteServerBehavior(sbObjs[0]);
    }
  }
  else if (bindingName)
  {
    alert(MM.MSG_CantDelColumn);
  }
}